//    CANAPE Network Testing Tool
//    Copyright (C) 2014 Context Information Security
//
//    This program is free software: you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation, either version 3 of the License, or
//    (at your option) any later version.
//
//    This program is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with this program.  If not, see <http://www.gnu.org/licenses/>.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using CANAPE.Utils;

namespace CANAPE.Nodes
{
    /// <summary>
    /// Interface to persist a node's state if required
    /// </summary>
    public interface IPersistNode
    {
        /// <summary>
        /// Get the objects state
        /// </summary>
        /// <param name="logger">The logger to use</param>
        /// <remarks>The object state must be a serializable object otherwise it might not be recoverable</remarks>
        /// <returns>The object's state</returns>
        object GetState(Logger logger);

        /// <summary>
        /// Set the objects state
        /// </summary>
        /// <param name="state">The state object</param>        
        /// <param name="logger">The logger to use</param>
        void SetState(object state, Logger logger);     
    }
}
